<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="description" content="API docs for the ActionController class from the spritewidget library, for the Dart programming language.">
  <title>ActionController class - spritewidget library - Dart API</title>
  <!-- required because all the links are pseudo-absolute -->
  <base href="..">

  <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
  <link rel="stylesheet" href="static-assets/github.css">
  <link rel="stylesheet" href="static-assets/styles.css">
  <link rel="icon" href="static-assets/favicon.png">

</head>

<body>

<div id="overlay-under-drawer"></div>

<header id="title">
  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="index.html">spritewidget</a></li>
    <li><a href="spritewidget/spritewidget-library.html">spritewidget</a></li>
    <li class="self-crumb">ActionController class</li>
  </ol>
  <div class="self-name">ActionController</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<main>

  <div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
    <h5>spritewidget library</h5>
    <ol>
      <li class="section-title"><a href="spritewidget/spritewidget-library.html#classes">Classes</a></li>
      <li><a href="spritewidget/Action-class.html">Action</a></li>
      <li><a href="spritewidget/ActionCallFunction-class.html">ActionCallFunction</a></li>
      <li><a href="spritewidget/ActionController-class.html">ActionController</a></li>
      <li><a href="spritewidget/ActionDelay-class.html">ActionDelay</a></li>
      <li><a href="spritewidget/ActionGroup-class.html">ActionGroup</a></li>
      <li><a href="spritewidget/ActionInstant-class.html">ActionInstant</a></li>
      <li><a href="spritewidget/ActionInterval-class.html">ActionInterval</a></li>
      <li><a href="spritewidget/ActionRemoveNode-class.html">ActionRemoveNode</a></li>
      <li><a href="spritewidget/ActionRepeat-class.html">ActionRepeat</a></li>
      <li><a href="spritewidget/ActionRepeatForever-class.html">ActionRepeatForever</a></li>
      <li><a href="spritewidget/ActionSequence-class.html">ActionSequence</a></li>
      <li><a href="spritewidget/ActionSpline-class.html">ActionSpline</a></li>
      <li><a href="spritewidget/ActionTween-class.html">ActionTween</a></li>
      <li><a href="spritewidget/ColorSequence-class.html">ColorSequence</a></li>
      <li><a href="spritewidget/Constraint-class.html">Constraint</a></li>
      <li><a href="spritewidget/ConstraintPositionToNode-class.html">ConstraintPositionToNode</a></li>
      <li><a href="spritewidget/ConstraintRotationToMovement-class.html">ConstraintRotationToMovement</a></li>
      <li><a href="spritewidget/ConstraintRotationToNode-class.html">ConstraintRotationToNode</a></li>
      <li><a href="spritewidget/ConstraintRotationToNodeRotation-class.html">ConstraintRotationToNodeRotation</a></li>
      <li><a href="spritewidget/EffectLine-class.html">EffectLine</a></li>
      <li><a href="spritewidget/GameMath-class.html">GameMath</a></li>
      <li><a href="spritewidget/ImageMap-class.html">ImageMap</a></li>
      <li><a href="spritewidget/Label-class.html">Label</a></li>
      <li><a href="spritewidget/Layer-class.html">Layer</a></li>
      <li><a href="spritewidget/NineSliceSprite-class.html">NineSliceSprite</a></li>
      <li><a href="spritewidget/Node-class.html">Node</a></li>
      <li><a href="spritewidget/Node3D-class.html">Node3D</a></li>
      <li><a href="spritewidget/NodeWithSize-class.html">NodeWithSize</a></li>
      <li><a href="spritewidget/ParticleSystem-class.html">ParticleSystem</a></li>
      <li><a href="spritewidget/Sprite-class.html">Sprite</a></li>
      <li><a href="spritewidget/SpriteBox-class.html">SpriteBox</a></li>
      <li><a href="spritewidget/SpriteBoxEvent-class.html">SpriteBoxEvent</a></li>
      <li><a href="spritewidget/SpritePaint-class.html">SpritePaint</a></li>
      <li><a href="spritewidget/SpriteSheet-class.html">SpriteSheet</a></li>
      <li><a href="spritewidget/SpriteTexture-class.html">SpriteTexture</a></li>
      <li><a href="spritewidget/SpriteWidget-class.html">SpriteWidget</a></li>
      <li><a href="spritewidget/TexturedLine-class.html">TexturedLine</a></li>
      <li><a href="spritewidget/TexturedLinePainter-class.html">TexturedLinePainter</a></li>
      <li><a href="spritewidget/VirtualJoystick-class.html">VirtualJoystick</a></li>
    
    
    
      <li class="section-title"><a href="spritewidget/spritewidget-library.html#functions">Functions</a></li>
      <li><a href="spritewidget/convertDegrees2Radians.html">convertDegrees2Radians</a></li>
      <li><a href="spritewidget/convertRadians2Degrees.html">convertRadians2Degrees</a></li>
      <li><a href="spritewidget/deserializeBlendMode.html">deserializeBlendMode</a></li>
      <li><a href="spritewidget/deserializeColor.html">deserializeColor</a></li>
      <li><a href="spritewidget/deserializeColorSequence.html">deserializeColorSequence</a></li>
      <li><a href="spritewidget/deserializeOffset.html">deserializeOffset</a></li>
      <li><a href="spritewidget/deserializeParticleSystem.html">deserializeParticleSystem</a></li>
      <li><a href="spritewidget/randomBool.html">randomBool</a></li>
      <li><a href="spritewidget/randomDouble.html">randomDouble</a></li>
      <li><a href="spritewidget/randomInt.html">randomInt</a></li>
      <li><a href="spritewidget/randomSignedDouble.html">randomSignedDouble</a></li>
      <li><a href="spritewidget/serializeBlendMode.html">serializeBlendMode</a></li>
      <li><a href="spritewidget/serializeColor.html">serializeColor</a></li>
      <li><a href="spritewidget/serializeColorSequence.html">serializeColorSequence</a></li>
      <li><a href="spritewidget/serializeOffset.html">serializeOffset</a></li>
      <li><a href="spritewidget/serializeParticleSystem.html">serializeParticleSystem</a></li>
    
      <li class="section-title"><a href="spritewidget/spritewidget-library.html#enums">Enums</a></li>
      <li><a href="spritewidget/EffectLineAnimationMode-class.html">EffectLineAnimationMode</a></li>
      <li><a href="spritewidget/EffectLineWidthMode-class.html">EffectLineWidthMode</a></li>
      <li><a href="spritewidget/SpriteBoxTransformMode-class.html">SpriteBoxTransformMode</a></li>
    
      <li class="section-title"><a href="spritewidget/spritewidget-library.html#typedefs">Typedefs</a></li>
      <li><a href="spritewidget/ActionCallback.html">ActionCallback</a></li>
      <li><a href="spritewidget/PointSetterCallback.html">PointSetterCallback</a></li>
      <li><a href="spritewidget/SetterCallback.html">SetterCallback</a></li>
    
    </ol>
  </div>

  <div class="col-xs-12 col-sm-9 col-md-8 main-content">
    <h1>ActionController class</h1>

    <section class="desc markdown">
      <p>A class the controls the playback of actions. To play back an action it is
passed to the <a href="spritewidget/ActionController-class.html">ActionController</a>'s <a href="spritewidget/ActionController/run.html">run</a> method. The <a href="spritewidget/ActionController-class.html">ActionController</a>
itself is typically a property of a <a href="spritewidget/Node-class.html">Node</a> and powered by the <a href="spritewidget/SpriteBox-class.html">SpriteBox</a>.</p>
    </section>
    

    <section class="summary offset-anchor" id="constructors">
      <h2>Constructors</h2>

      <dl class="constructor-summary-list">
        <dt id="ActionController" class="callable">
          <span class="name"><a href="spritewidget/ActionController/ActionController.html">ActionController</a></span><span class="signature">()</span>
        </dt>
        <dd>
          Creates a new <a href="spritewidget/ActionController-class.html">ActionController</a>. However, for most uses a reference to
an <a href="spritewidget/ActionController-class.html">ActionController</a> is acquired through the <a href="spritewidget/Node/actions.html">Node.actions</a> property.
        </dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="hashCode" class="property inherited">
          <span class="name"><a href="dart-core/Object/hashCode.html">hashCode</a></span>
          <span class="signature">&#8594; <a href="dart-core/int-class.html">int</a></span>
        </dt>
        <dd class="inherited">
          The hash code for this object. <a href="dart-core/Object/hashCode.html">[...]</a>
          <div class="features">read-only, inherited</div>
</dd>
        <dt id="runtimeType" class="property inherited">
          <span class="name"><a href="dart-core/Object/runtimeType.html">runtimeType</a></span>
          <span class="signature">&#8594; <a href="dart-core/Type-class.html">Type</a></span>
        </dt>
        <dd class="inherited">
          A representation of the runtime type of the object.
          <div class="features">read-only, inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor" id="instance-methods">
      <h2>Methods</h2>
      <dl class="callables">
        <dt id="run" class="callable">
          <span class="name"><a href="spritewidget/ActionController/run.html">run</a></span><span class="signature">(<wbr><span class="parameter" id="run-param-action"><span class="type-annotation"><a href="spritewidget/Action-class.html">Action</a></span> <span class="parameter-name">action</span>, [</span> <span class="parameter" id="run-param-tag"><span class="type-annotation"><a href="dart-core/Object-class.html">Object</a></span> <span class="parameter-name">tag</span></span> ])
            <span class="returntype parameter">&#8594; void</span>
          </span>
        </dt>
        <dd>
          Runs an <code>action</code>, can optionally be passed a <code>tag</code>. The <code>tag</code> can be used
to reference the action or a set of actions with the same tag. <a href="spritewidget/ActionController/run.html">[...]</a>
          
</dd>
        <dt id="step" class="callable">
          <span class="name"><a href="spritewidget/ActionController/step.html">step</a></span><span class="signature">(<wbr><span class="parameter" id="step-param-dt"><span class="type-annotation"><a href="dart-core/double-class.html">double</a></span> <span class="parameter-name">dt</span></span>)
            <span class="returntype parameter">&#8594; void</span>
          </span>
        </dt>
        <dd>
          Steps the action forward by the specified time, typically there is no need
to directly call this method.
          
</dd>
        <dt id="stop" class="callable">
          <span class="name"><a href="spritewidget/ActionController/stop.html">stop</a></span><span class="signature">(<wbr><span class="parameter" id="stop-param-action"><span class="type-annotation"><a href="spritewidget/Action-class.html">Action</a></span> <span class="parameter-name">action</span></span>)
            <span class="returntype parameter">&#8594; void</span>
          </span>
        </dt>
        <dd>
          Stops an <code>action</code> and removes it from the controller. <a href="spritewidget/ActionController/stop.html">[...]</a>
          
</dd>
        <dt id="stopAll" class="callable">
          <span class="name"><a href="spritewidget/ActionController/stopAll.html">stopAll</a></span><span class="signature">(<wbr>)
            <span class="returntype parameter">&#8594; void</span>
          </span>
        </dt>
        <dd>
          Stops all actions currently being run by the controller and removes them. <a href="spritewidget/ActionController/stopAll.html">[...]</a>
          
</dd>
        <dt id="stopWithTag" class="callable">
          <span class="name"><a href="spritewidget/ActionController/stopWithTag.html">stopWithTag</a></span><span class="signature">(<wbr><span class="parameter" id="stopWithTag-param-tag"><span class="type-annotation"><a href="dart-core/Object-class.html">Object</a></span> <span class="parameter-name">tag</span></span>)
            <span class="returntype parameter">&#8594; void</span>
          </span>
        </dt>
        <dd>
          Stops all actions with the specified tag and removes them from the
controller. <a href="spritewidget/ActionController/stopWithTag.html">[...]</a>
          
</dd>
        <dt id="noSuchMethod" class="callable inherited">
          <span class="name"><a href="dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
            <span class="returntype parameter">&#8594; dynamic</span>
          </span>
        </dt>
        <dd class="inherited">
          Invoked when a non-existent method or property is accessed. <a href="dart-core/Object/noSuchMethod.html">[...]</a>
          <div class="features">inherited</div>
</dd>
        <dt id="toString" class="callable inherited">
          <span class="name"><a href="dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
            <span class="returntype parameter">&#8594; <a href="dart-core/String-class.html">String</a></span>
          </span>
        </dt>
        <dd class="inherited">
          Returns a string representation of this object.
          <div class="features">inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="operators">
      <h2>Operators</h2>
      <dl class="callables">
        <dt id="operator ==" class="callable inherited">
          <span class="name"><a href="dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span>)
            <span class="returntype parameter">&#8594; <a href="dart-core/bool-class.html">bool</a></span>
          </span>
        </dt>
        <dd class="inherited">
          The equality operator. <a href="dart-core/Object/operator_equals.html">[...]</a>
          <div class="features">inherited</div>
</dd>
      </dl>
    </section>




  </div> <!-- /.main-content -->

  <div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
    <ol>
      <li class="section-title"><a href="spritewidget/ActionController-class.html#constructors">Constructors</a></li>
      <li><a href="spritewidget/ActionController/ActionController.html">ActionController</a></li>
    
      <li class="section-title inherited">
        <a href="spritewidget/ActionController-class.html#instance-properties">Properties</a>
      </li>
      <li class="inherited"><a href="dart-core/Object/hashCode.html">hashCode</a></li>
      <li class="inherited"><a href="dart-core/Object/runtimeType.html">runtimeType</a></li>
    
      <li class="section-title"><a href="spritewidget/ActionController-class.html#instance-methods">Methods</a></li>
      <li><a href="spritewidget/ActionController/run.html">run</a></li>
      <li><a href="spritewidget/ActionController/step.html">step</a></li>
      <li><a href="spritewidget/ActionController/stop.html">stop</a></li>
      <li><a href="spritewidget/ActionController/stopAll.html">stopAll</a></li>
      <li><a href="spritewidget/ActionController/stopWithTag.html">stopWithTag</a></li>
      <li class="inherited"><a href="dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
      <li class="inherited"><a href="dart-core/Object/toString.html">toString</a></li>
    
      <li class="section-title inherited"><a href="spritewidget/ActionController-class.html#operators">Operators</a></li>
      <li class="inherited"><a href="dart-core/Object/operator_equals.html">operator ==</a></li>
    
    
    
    </ol>
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    spritewidget 0.9.16
  </span>

</footer>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="static-assets/typeahead.bundle.min.js"></script>
<script src="static-assets/highlight.pack.js"></script>
<script src="static-assets/URI.js"></script>
<script src="static-assets/script.js"></script>


</body>

</html>
